Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation to codify MPI and BLAS/LAPACK library choices & link rubydoc #6209

Merged
merged 2 commits into from
Jun 7, 2019

Conversation

zbeekman
Copy link
Contributor

@zbeekman zbeekman commented Jun 4, 2019

  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same change?
  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • Have you written new tests for your changes? Here's an example. N/A docs only
  • Have you successfully run brew style with your changes locally?
  • Have you successfully run brew tests with your changes locally?

Explanation of changes:

All documentation changes.

Formalize:

  • Usage of OpenMPI over MPICH
  • Usage of OpenBLAS over Accelerate or lapack

Add a link to https://rubydoc.brew.sh to https://docs.brew.sh because I'm a derp and can never remember where it is. Also, it would be good to start getting the up-to-date developer documentation higher in search rankings than the old outdated version.

@zbeekman zbeekman changed the title Mpi blas doc update Update documentation to codify MPI and BLAS/LAPACK library choices & link rubydoc Jun 4, 2019
docs/Formula-Cookbook.md Outdated Show resolved Hide resolved
Copy link
Member

@MikeMcQuaid MikeMcQuaid left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One change otherwise 👍

docs/Acceptable-Formulae.md Outdated Show resolved Hide resolved
@zbeekman zbeekman changed the title Update documentation to codify MPI and BLAS/LAPACK library choices & link rubydoc Update documentation & cops to codify MPI and BLAS/LAPACK library choices & link rubydoc Jun 5, 2019
@@ -50,6 +50,7 @@
- [Brew Test Bot For Maintainers](Brew-Test-Bot-For-Core-Contributors.md)
- [Common Issues for Maintainers](Common-Issues-for-Core-Contributors.md)
- [Releases](Releases.md)
- [Developer/Internal API Documentation](https://rubydoc.brew.sh)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I renamed this to avoid confusion with more public facing APIs like formulae.brew.sh

@zbeekman zbeekman mentioned this pull request Jun 6, 2019
6 tasks
@zbeekman zbeekman changed the title Update documentation & cops to codify MPI and BLAS/LAPACK library choices & link rubydoc Update documentation to codify MPI and BLAS/LAPACK library choices & link rubydoc Jun 6, 2019
@zbeekman zbeekman changed the title Update documentation to codify MPI and BLAS/LAPACK library choices & link rubydoc Ready: Update documentation to codify MPI and BLAS/LAPACK library choices & link rubydoc Jun 6, 2019
zbeekman added a commit to zbeekman/brew that referenced this pull request Jun 6, 2019
 - Split off from PR Homebrew#6209
 - Create stand alone class for cop w/ auto-correct
@MikeMcQuaid MikeMcQuaid changed the title Ready: Update documentation to codify MPI and BLAS/LAPACK library choices & link rubydoc Update documentation to codify MPI and BLAS/LAPACK library choices & link rubydoc Jun 7, 2019
@MikeMcQuaid
Copy link
Member

Thanks @zbeekman!

@MikeMcQuaid MikeMcQuaid merged commit e9adaaa into Homebrew:master Jun 7, 2019
@lock lock bot added the outdated PR was locked due to age label Jan 1, 2020
@lock lock bot locked as resolved and limited conversation to collaborators Jan 1, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
outdated PR was locked due to age
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants